<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>ProxyOptions | opine-http-proxy</title>
	<meta name="description" content="Documentation for opine-http-proxy">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">opine-http-proxy</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="../modules/_resolveoptions_.html">&quot;resolveOptions&quot;</a>
				</li>
				<li>
					<a href="_resolveoptions_.proxyoptions.html">ProxyOptions</a>
				</li>
			</ul>
			<h1>Interface ProxyOptions</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Interface for the proxy options which allow the user
							to filter, customize and decorate proxied requests and
						responses.</p>
					</div>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="tsd-signature-symbol">{}</span>
						<ul class="tsd-hierarchy">
							<li>
								<span class="target">ProxyOptions</span>
							</li>
						</ul>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#filterreq" class="tsd-kind-icon">filter<wbr>Req</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#filterres" class="tsd-kind-icon">filter<wbr>Res</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#memoizeurl" class="tsd-kind-icon">memoize<wbr>Url</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-private"><a href="_resolveoptions_.proxyoptions.html#memoizedurl" class="tsd-kind-icon">memoized<wbr>Url</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#method" class="tsd-kind-icon">method</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#parsereqbody" class="tsd-kind-icon">parse<wbr>Req<wbr>Body</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#preservehostheader" class="tsd-kind-icon">preserve<wbr>Host<wbr>Header</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#proxyerrorhandler" class="tsd-kind-icon">proxy<wbr>Error<wbr>Handler</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#proxyreqinitdecorator" class="tsd-kind-icon">proxy<wbr>Req<wbr>Init<wbr>Decorator</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#proxyrequrldecorator" class="tsd-kind-icon">proxy<wbr>Req<wbr>Url<wbr>Decorator</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#reqasbuffer" class="tsd-kind-icon">req<wbr>AsBuffer</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#reqbodyencoding" class="tsd-kind-icon">req<wbr>Body<wbr>Encoding</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#secure" class="tsd-kind-icon">secure</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#srcresdecorator" class="tsd-kind-icon">src<wbr>Res<wbr>Decorator</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#srcresheaderdecorator" class="tsd-kind-icon">src<wbr>Res<wbr>Header<wbr>Decorator</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-private"><a href="_resolveoptions_.proxyoptions.html#stream" class="tsd-kind-icon">stream</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_resolveoptions_.proxyoptions.html#timeout" class="tsd-kind-icon">timeout</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="filterreq" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr>Req</h3>
					<div class="tsd-signature tsd-kind-icon">filter<wbr>Req<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L22">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:22</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The filter request option can be used to limit what requests are
							proxied.</p>
						</div>
						<p>Return false to continue to execute the proxy; return true to skip the
						proxy for this request.</p>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>req: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>res: <span class="tsd-signature-type">any</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="filterres" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr>Res</h3>
					<div class="tsd-signature tsd-kind-icon">filter<wbr>Res<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>proxyRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span>, proxyResData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L91">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:91</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The filter response option can be used to limit what responses are
							used from the proxy.</p>
						</div>
						<p>Return false to continue to execute the proxy; return true to skip the
						proxy for this request.</p>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>proxyRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span>, proxyResData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>proxyRes: <span class="tsd-signature-type">Response</span></h5>
											</li>
											<li>
												<h5>proxyResData: <span class="tsd-signature-type">any</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="memoizeurl" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> memoize<wbr>Url</h3>
					<div class="tsd-signature tsd-kind-icon">memoize<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L137">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:137</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configure whether the proxy URL should be memoized for subsequent
							requests.</p>
						</div>
						<p>If you are using the function form of the URL and require it to
						be executed on every request then this should be set to false.</p>
						<p>True by default.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-private">
					<a name="memoizedurl" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagPrivate">Private</span> memoized<wbr>Url</h3>
					<div class="tsd-signature tsd-kind-icon">memoized<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L145">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:145</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The memoized url set on first request and used internally if
							<code>memoizeUrl</code> is set to true.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="method" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> method</h3>
					<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L170">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:170</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configure the HTTP method (verb) used for the outbound proxied
							request. If not provided the current request method is used.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="parsereqbody" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> parse<wbr>Req<wbr>Body</h3>
					<div class="tsd-signature tsd-kind-icon">parse<wbr>Req<wbr>Body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L109">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:109</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configure whether the request body should be parsed and used on
							proxied requests.</p>
						</div>
						<p>True by default.</p>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="preservehostheader" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> preserve<wbr>Host<wbr>Header</h3>
					<div class="tsd-signature tsd-kind-icon">preserve<wbr>Host<wbr>Header<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L99">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:99</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configure whether the &quot;Host&quot; header should be preserved on proxied
							requests.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="proxyerrorhandler" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy<wbr>Error<wbr>Handler</h3>
					<div class="tsd-signature tsd-kind-icon">proxy<wbr>Error<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, next<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L32">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:32</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Provide a custom error handling for failed proxied requests.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, next<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>err: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>res: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>next: <span class="tsd-signature-type">any</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="proxyreqinitdecorator" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy<wbr>Req<wbr>Init<wbr>Decorator</h3>
					<div class="tsd-signature tsd-kind-icon">proxy<wbr>Req<wbr>Init<wbr>Decorator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>proxyReqOpts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInit</span>, srcReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L52">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:52</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Decorate the outbound proxied request initialization options.
								This configuration will be used within the <code>fetch</code> method internally
							to make the request to the provided url.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>proxyReqOpts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInit</span>, srcReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">&gt;</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>proxyReqOpts: <span class="tsd-signature-type">RequestInit</span></h5>
											</li>
											<li>
												<h5>srcReq: <span class="tsd-signature-type">any</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">&gt;</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="proxyrequrldecorator" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> proxy<wbr>Req<wbr>Url<wbr>Decorator</h3>
					<div class="tsd-signature tsd-kind-icon">proxy<wbr>Req<wbr>Url<wbr>Decorator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">URL</span>, req<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L43">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:43</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Decorate the outbound proxied request url.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">URL</span>, req<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol">&gt;</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>url: <span class="tsd-signature-type">URL</span></h5>
											</li>
											<li>
												<h5><span class="tsd-flag ts-flagOptional">Optional</span> req: <span class="tsd-signature-type">any</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">URL</span><span class="tsd-signature-symbol">&gt;</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="reqasbuffer" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> req<wbr>AsBuffer</h3>
					<div class="tsd-signature tsd-kind-icon">req<wbr>AsBuffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L124">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:124</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configure whether the request body should be sent as a UInt8Array
							buffer.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="reqbodyencoding" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> req<wbr>Body<wbr>Encoding</h3>
					<div class="tsd-signature tsd-kind-icon">req<wbr>Body<wbr>Encoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"utf-8"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L116">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:116</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The request body encoding to use. Only &quot;utf-8&quot; currently supported.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="secure" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> secure</h3>
					<div class="tsd-signature tsd-kind-icon">secure<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L154">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:154</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configure whether the outbound proxied request should be over
								HTTPS. This will always override the protocol produced by the provided
							proxy URL if set to <code>true</code>.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="srcresdecorator" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> src<wbr>Res<wbr>Decorator</h3>
					<div class="tsd-signature tsd-kind-icon">src<wbr>Res<wbr>Decorator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>srcReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, srcRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, proxyRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span>, proxyResData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L75">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:75</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Decorate the inbound response object from the proxied request.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>srcReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, srcRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, proxyRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span>, proxyResData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>srcReq: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>srcRes: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>proxyRes: <span class="tsd-signature-type">Response</span></h5>
											</li>
											<li>
												<h5>proxyResData: <span class="tsd-signature-type">any</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="srcresheaderdecorator" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> src<wbr>Res<wbr>Header<wbr>Decorator</h3>
					<div class="tsd-signature tsd-kind-icon">src<wbr>Res<wbr>Header<wbr>Decorator<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Headers</span>, srcReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, srcRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, proxyReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Request</span>, proxyRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Headers</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L62">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:62</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Decorate the inbound response headers from the proxied request.</p>
						</div>
					</div>
					<div class="tsd-type-declaration">
						<h4>Type declaration</h4>
						<ul class="tsd-parameters">
							<li class="tsd-parameter-signature">
								<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-property">
									<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>headers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Headers</span>, srcReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, srcRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, proxyReq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Request</span>, proxyRes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Headers</span></li>
								</ul>
								<ul class="tsd-descriptions">
									<li class="tsd-description">
										<h4 class="tsd-parameters-title">Parameters</h4>
										<ul class="tsd-parameters">
											<li>
												<h5>headers: <span class="tsd-signature-type">Headers</span></h5>
											</li>
											<li>
												<h5>srcReq: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>srcRes: <span class="tsd-signature-type">any</span></h5>
											</li>
											<li>
												<h5>proxyReq: <span class="tsd-signature-type">Request</span></h5>
											</li>
											<li>
												<h5>proxyRes: <span class="tsd-signature-type">Response</span></h5>
											</li>
										</ul>
										<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Headers</span></h4>
									</li>
								</ul>
							</li>
						</ul>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-private">
					<a name="stream" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagPrivate">Private</span> stream</h3>
					<div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L175">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:175</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="timeout" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout</h3>
					<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine-http-proxy/blob/2d1630c/src/resolveOptions.ts#L162">home/runner/work/opine-http-proxy/opine-http-proxy/src/resolveOptions.ts:162</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Configure a timeout in ms for the outbound proxied request. If not
							provided the request will never time out.</p>
						</div>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_createstate_.html">&quot;create<wbr>State&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_isunset_.html">&quot;is<wbr>Unset&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_proxy_.html">&quot;proxy&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_requestoptions_.html">&quot;request<wbr>Options&quot;</a>
					</li>
					<li class="current tsd-kind-module">
						<a href="../modules/_resolveoptions_.html">&quot;resolve<wbr>Options&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_buildproxyreqinit_.html">&quot;steps/build<wbr>Proxy<wbr>Req<wbr>Init&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_buildproxyurl_.html">&quot;steps/build<wbr>Proxy<wbr>Url&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_copyproxyresheaderstouserres_.html">&quot;steps/copy<wbr>Proxy<wbr>Res<wbr>Headers<wbr>ToUser<wbr>Res&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decorateproxyreqinit_.html">&quot;steps/decorate<wbr>Proxy<wbr>Req<wbr>Init&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decorateproxyrequrl_.html">&quot;steps/decorate<wbr>Proxy<wbr>Req<wbr>Url&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decoratesrcres_.html">&quot;steps/decorate<wbr>Src<wbr>Res&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_decoratesrcresheaders_.html">&quot;steps/decorate<wbr>Src<wbr>Res<wbr>Headers&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_filterproxyres_.html">&quot;steps/filter<wbr>Proxy<wbr>Res&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_filtersrcreq_.html">&quot;steps/filter<wbr>Src<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_handleproxyerrors_.html">&quot;steps/handle<wbr>Proxy<wbr>Errors&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_prepareproxyreq_.html">&quot;steps/prepare<wbr>Proxy<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_sendproxyreq_.html">&quot;steps/send<wbr>Proxy<wbr>Req&quot;</a>
					</li>
					<li class=" tsd-kind-module">
						<a href="../modules/_steps_sendsrcres_.html">&quot;steps/send<wbr>Src<wbr>Res&quot;</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface tsd-parent-kind-module">
						<a href="_resolveoptions_.proxyoptions.html" class="tsd-kind-icon">Proxy<wbr>Options</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#filterreq" class="tsd-kind-icon">filter<wbr>Req</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#filterres" class="tsd-kind-icon">filter<wbr>Res</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#memoizeurl" class="tsd-kind-icon">memoize<wbr>Url</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-private">
								<a href="_resolveoptions_.proxyoptions.html#memoizedurl" class="tsd-kind-icon">memoized<wbr>Url</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#method" class="tsd-kind-icon">method</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#parsereqbody" class="tsd-kind-icon">parse<wbr>Req<wbr>Body</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#preservehostheader" class="tsd-kind-icon">preserve<wbr>Host<wbr>Header</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#proxyerrorhandler" class="tsd-kind-icon">proxy<wbr>Error<wbr>Handler</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#proxyreqinitdecorator" class="tsd-kind-icon">proxy<wbr>Req<wbr>Init<wbr>Decorator</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#proxyrequrldecorator" class="tsd-kind-icon">proxy<wbr>Req<wbr>Url<wbr>Decorator</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#reqasbuffer" class="tsd-kind-icon">req<wbr>AsBuffer</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#reqbodyencoding" class="tsd-kind-icon">req<wbr>Body<wbr>Encoding</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#secure" class="tsd-kind-icon">secure</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#srcresdecorator" class="tsd-kind-icon">src<wbr>Res<wbr>Decorator</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#srcresheaderdecorator" class="tsd-kind-icon">src<wbr>Res<wbr>Header<wbr>Decorator</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-private">
								<a href="_resolveoptions_.proxyoptions.html#stream" class="tsd-kind-icon">stream</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_resolveoptions_.proxyoptions.html#timeout" class="tsd-kind-icon">timeout</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
					<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private tsd-is-not-exported">
						<a href="../modules/_resolveoptions_.html#resolvebodyencoding" class="tsd-kind-icon">resolve<wbr>Body<wbr>Encoding</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private">
						<a href="../modules/_resolveoptions_.html#resolveoptions" class="tsd-kind-icon">resolve<wbr>Options</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>